<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Listing Group Element</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<h1>ListingGroup</h1>

<p>Abstract element that represents the behavior common to 
list and table groups.</p>

<h3>Description</h3>

<p>A list or table is most often divided into a number of 
groups. Groups provide a way of showing common headings for a group of related 
rows. Groups often have subtotals. For example, a sales report may show totals 
per sales rep and region.</p>
<p>A group is defined by a <i>group key.</i> The key is a 
column from the query. If the group key is a time field then user often want to 
group on an <i>interval</i> such as month or quarter.</p>

<h3>See Also</h3>

<h2 class="property">groupName</h2>

<p>Optional name of the group.</p>

<h3>Description</h3>
<p>Optional name of the group. The group name must be unique 
within the list or table. The name is used to identify the group in aggregates 
as explained in the scripting specification.</p>

<h3>See Also</h3>
<h2 class="property">keyExpr</h2>

<p>The expression for the group key.</p>

<h3>Description</h3>
<p>Gives the group key as an expression. The group key says 
when to cause a group break listing. For example, if the group is by state, then 
the group key might be &quot;<code>row.state</code>&quot;. A level break 
occurs each time the key changes. At each level break, the current group is 
ended, and a new group started. The expression most often is just a column, but 
can be a computed value.</p>

<h3>See Also</h3>

<h2 class="property">eventHandlerClass</h2>
<p>The full qulified name of the event handler class.</p>

<h3>Description</h3>
<p>Full quilified name of the event handler class, used to specify an external Java class
which define the scripting behavior that will be executed at runtime.</p>


<h2 class="property">intervalBase</h2>

<p>In conjunction with Interval and IntervalRange, determines how data is divided into groups.</p>

<h3>Description</h3>
<p>In conjunction with Interval and IntervalRange, determines how data is divided into groups.</p>

<h2 class="property">interval</h2>

<p>When creating intervals, this property allows grouping on a range of contiguous values.</p>

<h3>Choices</h3>
<ul>
<li>none: Group on individual 
    values.</li>

<li>prefix: Group on a string 
    prefix</li>

<li>year: Group on a range of 
    years.</li>

<li>quarter: Group on a range of 
    quarters.</li>

<li>month: Group on a range of 
    months.</li>

<li>week: Group on a range of 
    weeks.</li>

<li>day: Group on a range of 
    days.</li>

<li>hour: Group on a range of 
    hours.</li>

<li>minute: Group on a range of 
    minutes.</li>

<li>second: Group on a range of 
    seconds.</li>

<li>interval: Group on a numeric 
    interval.</li>

</ul>
<h3>Description</h3>
<p>This property allows the group to include a range of 
contiguous values. For example, a monthly sales report may want to summarize a 
list of individual transactions, each of which has a transaction date. Using the 
Month interval, BIRT will cause a break to occur each time the transaction dates 
move into a different calendar month.</p>
<p>Use this property with the <code>
intervalRange</code> property to select a set of contiguous values. For example, 
a bi-monthly report would use the Month <code>interval</code> 
with an <code>intervalRange</code> of 2.</p>

<h3>See Also</h3>
<p><code>intervalRange</code> Property</p>

<h2 class="property">intervalRange</h2>

<p>Number of contiguous groups to merge to create a single group.</p>

<h3>Description</h3>
<p>When creating intervals, this attribute allows grouping 
on a range of contiguous values. For example, to show data over the span of 
three hours, set the grouping interval to hours and the range to 3. The user 
enters the interval range here.</p>
<p>The following shows the meaning of the range for each 
interval type.</p>
<table class="section-table">
  <thead>
    <tr>
      <td>
      Interval</td>
      <td>
      Meaning of Range</td>
    </tr>
  </thead>
  <tr>
    <td>
    None</td>
    <td>
    &nbsp;Ignored</td>
  </tr>
  <tr>
    <td>
    Prefix</td>
    <td>
    &nbsp;The number of characters in the prefix.</td>
  </tr>
  <tr>
    <td>
    Date/Time</td>
    <td>
    &nbsp;The number of the units.</td>
  </tr>
  <tr>
    <td>
    Interval</td>
    <td>
    &nbsp;The numeric interval</td>
  </tr>
</table>
<p></p>

<h3>See Also</h3>
<p><code>interval</code> Property</p>

<h2 class="property">sortDirection</h2>

<p>The sort direction for the groups at this level.</p>

<h3>Choices</h3>
<ul>
<li>asc: Sort values from lowest 
    to highest.</li>

<li>desc: Sort values from 
    highest to lowest.</li>

</ul>
<h3>Description</h3>
<p>The sort direction applies only if the List does not have 
a custom sort defined using the <code>sort</code> property. The 
default group sort key is the group key.</p>
<h3>See Also</h3>
<p><code>sort</code> Property</p>

<h2 class="property">toc</h2>

<p>The table of contents expression for this group.</p>

<h3>Description</h3>
<p>The table of contents (TOC) expression for the group. The 
value of the expression appears for the table of contents for the report.</p>

<h3>See Also</h3>
<h2 class="property">filter</h2>

<p>A filter to apply to the each group as a whole.</p>

<h3>Description</h3>
<p>A filter to apply to the each group as a whole. The 
filter conditions should apply to values that are constant for each group. This 
means that the filter expressions should be <i>functionally dependent &nbsp;</i>on 
the group key, or should be defined on aggregates computed over the group. For 
example, display only customers with non-zero sales totals, or display only the 
top 10 customers as determined by sales.</p>

<h3>See Also</h3>
<h2 class="property">sort</h2>

<p>Custom sort criteria to apply to the groups as a whole.</p>

<h3>Description</h3>
<p>Custom sort criteria to apply to the groups as a whole. 
For example, the report may group customers by customer ID, but sort the 
customers by total sales or by customer name.</p>

<h3>See Also</h3>
<p><code>sortDirection</code> property</p>

<h2 class="property">sortType</h2>
<p>Sort type property</p>

<h3>Description</h3>
<p>Sort type</p>

<h3>See Also</h3>


</body>
</html>